home *** CD-ROM | disk | FTP | other *** search
/ Gold Medal Software 3 / Gold Medal Software - Volume 3 (Gold Medal) (1994).iso / comms / icom0425.arj / AUTOICOM.DOC < prev    next >
Text File  |  1994-04-25  |  23KB  |  420 lines
  1.  
  2.  
  3.  
  4.  
  5.  
  6.                                   Intellicomm (TM)
  7.                                        v2.01
  8.        Copyright (C) 1991-1994 Liberation Enterprises.  All rights reserved.
  9.        ---------------------------------------------------------------------
  10.                           INTELLICOMM AUTO-BIF INFORMATION
  11.        ---------------------------------------------------------------------
  12.  
  13.      1  What is an Auto-BIF?
  14.  
  15.      An auto-BIF is simply a working BIF for a BBS that has had some minor
  16.      modifications made to it, been ZIPped up into an archive called
  17.      ICOMAUTO.ZIP, then uploaded to a BBS.  When fellow Intellicomm users call
  18.      a BBS, they first try to download ICOMAUTO.ZIP.  If the download is
  19.      successful, Icom extracts the BIF, asks the user for his/her logon name
  20.      (and perhaps date of birth and home phone number if necessary for
  21.      logons), then configures itself for full automation on the BBS in
  22.      seconds.  When an ICOMAUTO.ZIP is available, no BIF Learn is necessary,
  23.      no prompt tweaking is necessary, and no hassles of any sort stand in the
  24.      way of automated calls.  Just a simple download sets every Icom user on
  25.      the BBS up for full automation.
  26.  
  27.      The idea is that there's no need for every Intellicomm user to repeat the
  28.      exact same BIF setup work, on every single BBS ... the ICOMAUTO.ZIP
  29.      concept eliminates unnecessary work.  If you have a fully working BIF for
  30.      a BBS, you might as well ZIP the BIF up and upload it as ICOMAUTO.ZIP. 
  31.      It'll only take you a couple of minutes, other Icom users will be doing
  32.      it for you at *other* BBS's, thus allowing you to avoid the BIF setup
  33.      elsewhere, and everyone wins.  
  34.  
  35.      2  HOW THEY'RE USED
  36.  
  37.      When Intellicomm users logon to a new BBS, they first always look for a
  38.      file called ICOMAUTO.ZIP.  If this file is found all the user need do is
  39.      download it.  Intellicomm keeps an eye out for files called ICOMAUTO.*
  40.      (any extension) after downloads and if one or more are found, when the
  41.      user disconnects, Icom will:
  42.  
  43.       o   Automatically uncompress each ICOMAUTO.* to a temporary directory
  44.           (handling each ICOMAUTO fully before moving on to the next, if
  45.           multiple ICOMAUTO.ZIPs were downloaded from different BBS's).  If
  46.           *.BIF is found in the temporary directory after uncompressing, the
  47.           original ICOMAUTO.* archive is renamed to ICOMAnnn.* (nnn being a
  48.           number from 000 to 999) to avoid processiong the same file twice.
  49.  
  50.        o  Installs *.BIF from the temporary directory to the user's BIF
  51.           Directory.  If the user already had a file of the same name, Icom
  52.           opens the existing BIF and gets the user's existing password, #
  53.           times connected and last date connected (these items are saved and
  54.           copied to the new incoming BIFs).  The existing file is then renamed
  55.           to BIFNAME.OLD (if a previous .OLD exists, it's first deleted before
  56.           the rename).
  57.  
  58.        o  Appends *.NEW to the user's existing .NEW listing(s) (if any).  The
  59.           .NEW list would contain important files that new users of the BBS
  60.           may be interested in.  You needn't include a .NEW list in
  61.           ICOMAUTO.ZIP, but it's a nice touch.
  62.  
  63.  
  64.  
  65.  
  66.      Intellicomm v2.01             AUTOICOM.DOC                             2
  67.      
  68.      
  69.  
  70.        o  Next, the 'Port Settings' in the BIF are adjusted to suit the user's
  71.           default modem speed.  Only the speed is adjusted, so you can, for
  72.           example, set the BIF up to use 2400,E,7,1 (even parity, 7 data bits,
  73.           1 stop bit), and Intellicomm will leave the E,7,1 as is, and will
  74.           replace the 2400 speed with the user's default port speed. 
  75.           Intellicomm's 'Auto Baud Adjust' will take care of the rest when the
  76.           user connects.
  77.  
  78.        o  Next the BIF Notes (if any) are displayed.  Notes are entered by
  79.           selecting "Notes" while in the BIF Editor, and they can be used to
  80.           welcome new users to the BBS, outline BBS rules, point of special
  81.           file areas or message conferences ... any information you might want
  82.           a new Intellicomm user to know about a particular BBS.  The notes
  83.           remain on the screen so you can include special setup information
  84.           for the next two steps below.
  85.  
  86.        o  Next Intellicomm asks for the user's BBS PASSWORD, if s/he has no
  87.           password defined for the BIF.  (Since the password data is stored
  88.           separately, it is possible that the user has already set a password
  89.           up for the BBS/BIF, and has just recently found ICOMAUTO.ZIP).  If a
  90.           previous BIF of the same name existed before installation of this
  91.           new BIF, the existing password is used and the user is not prompted
  92.           for a password.
  93.  
  94.        o  Next Intellicomm goes through the .BIF itself (we're talking about
  95.           the .BIF that was included in the ICOMAUTO.ZIP here) looking for any
  96.           'replaceable parameters'.  These parameters are surrounded by
  97.           percent (%) signs, and when found they tell Intellicomm to ask the
  98.           user for certain information, and then 'replace' the %PARM% with
  99.           whatever the user entered.  The parameters available are:
  100.  
  101.             %FIRST%      Asks for the user's logon FIRST NAME for the BBS
  102.             %LAST%       Asks for the user's logon LAST NAME
  103.             %BDATE%      Asks for the user's BIRTH DATE (for logons)
  104.             %HPHONE%     Asks for the user's HOME PHONE NUMBER (for logons)
  105.             %PNAME%      Asks for a 'Message Type' PACKET FILENAME, where
  106.                          'Message Type' is the type of message system (e.g.
  107.                          Qmail v4 PACKET FILENAME).
  108.             %DOOR%       Asks for a DOOR #/NAME to "do whatever".  The "do
  109.                          whatever" is the description of the BIF item as given
  110.                          in the BIF Editor (e.g. Enter DOOR #/NAME to 'Access
  111.                          Msg. Menu').
  112.  
  113.           A default is offered wherever possible (the user's proper first or
  114.           last name, birth date, and home phone is offered from the main
  115.           setup, and the BIFNAME is offered as a default %PNAME%).
  116.  
  117.           The response given by the user is saved in memory and the next time
  118.           Intellicomm runs across the same parameter in the same BIF, it
  119.           doesn't ask the user for the information, it simply replaces it
  120.           automatically (all except %DOOR% which is prompted for each time). 
  121.           This can be handy, for example, if you need to use the mail packet
  122.           name or the user's name in a BBS prompt.  Icom will ask the user for
  123.           the info, get the proper response, then replace any further
  124.  
  125.  
  126.  
  127.  
  128.      Intellicomm v2.01             AUTOICOM.DOC                             3
  129.      
  130.      
  131.  
  132.           occurrences of this variable automatically.  The responses the user
  133.           enters for each parameter are cleared between each BIF.
  134.  
  135.           Keep in mind that the BIF Notes are displayed on the screen while
  136.           these replaceable parameters are being entered, so you can place any
  137.           extra help there if needed.  The Wildcat v3 template asks for the
  138.           user's %HPHONE%, and Wildcat expects the phone number as AAAEEENNNN
  139.           (area code, exchange, number).  So the BIF Notes in the Wildcat
  140.           template tell the user HOW to enter the information, when
  141.           Intellicomm asks for it.
  142.  
  143.           Note that you may still use % in your BIF commands with no problems
  144.           (and a single % is still used on the BIF "File" screen as a
  145.           placeholder for various things).  You could even define %PHONE% in a
  146.           BIF (rather than %HPHONE%) and Intellicomm would ignore it/send it
  147.           as a regular BBS command or watch for it, if defined as a prompt. 
  148.           Replaceable parameters must match EXACTLY to have any effect, and
  149.           case IS significant (%hphone% won't work either).
  150.  
  151.        o  After all replaceable parameters are processed, Intellicomm saves
  152.           the BIF to disk, adds it to the user's BBS Dir (internal Icom menu),
  153.           then, for the icing on the cake, asks the user whether to Create a
  154.           standard set of Jobs for the BBS!  The Jobs created are the usual
  155.           fare: Logon/Switch to Manual - BIFNAME, Send/Get Mail - BIFNAME, and
  156.           Send/Get Files - BIFNAME.
  157.  
  158.        o  Once ALL Auto-BIFs have been installed, set up and saved to disk,
  159.           and the temporary directory has been deleted, the Tagger will then
  160.           be called to import *.NEW (new files lists from the ICOMAUTO.ZIP
  161.           files) into the user's catalogs for his/her perusal.
  162.  
  163.      As mentioned above, all the user need do is download ICOMAUTO.* to set
  164.      this chain of events into action.  But instead of downloading the file,
  165.      if you simply give the ICOMAUTO archive to a friend on-disk, the user can
  166.      simply COPY ICOMAUTO.* into his/her global 'Download Dir', and
  167.      Intellicomm will find and install the file on its next startup.  The user
  168.      could also extract ICOMAUTO.ZIP him/herself and just COPY *.BIF into the
  169.      BIF directory... Intellicomm will find it there too (assuming a file of
  170.      the same name didn't already exist; if it did Intellicomm won't notice
  171.      anything new).
  172.  
  173.      Replaceable parameters are also processed when you "Create" or "Edit" a
  174.      Job from the BIF Editor, when you select a new Message/Bank Type, and
  175.      when you "Merge" a BIF Template into an existing BIF.  Thus many
  176.      replaceable parms are also used in the BIF Templates and Message/Bank
  177.      Type Files (*.MTF, *.BTF).
  178.  
  179.      WHO CAN SET UP AN AUTO-BIF?
  180.  
  181.      The main purpose of the Auto-BIF is to allow many people to benefit from
  182.      the achievement of one user, and only ONE person per BBS will set up an
  183.      ICOMAUTO.ZIP.  It might as well be you, if you have a working BIF for the
  184.      BBS.  If you upload one, you may be repaid the favour someday when you
  185.      call a new BBS and find an ICOMAUTO.ZIP that someone *else* uploaded. 
  186.  
  187.  
  188.  
  189.  
  190.      Intellicomm v2.01             AUTOICOM.DOC                             4
  191.      
  192.      
  193.  
  194.      The idea is to eliminate work... there's no sense in everyone setting up
  195.      a BIF.  With ICOMAUTO, as soon as ONE person gets a BIF working, everyone
  196.      else can benefit, and vice versa when you log onto new BBS's.
  197.  
  198.      Of course, the best person to set up an Auto-BIF is the System Operator
  199.      of the BBS.  The Sysop knows the BBS inside-out and will have little
  200.      trouble filling in the various prompts/commands.  Another advantage the
  201.      Sysop has is direct access to the file ICOMAUTO.ZIP (where the Auto-BIF
  202.      is stored on each BBS).  S/he can modify this file whenever necessary,
  203.      without having to worry about how to re-upload it and overwrite the old
  204.      file if necessary.  The Sysop also knows where and when changes will be
  205.      made to the BBS that will affect the Auto-BIF.  Finally, the Sysop can
  206.      also include special 'notes' in the Auto-BIF, pointing out special
  207.      features of the BBS and any important information about the BBS that all
  208.      users need to know.  Since the notes are automatically displayed when
  209.      Intellicomm installs the BIF, it's a good place for a Sysop to
  210.      communicate with new users.  Intellicomm may even be for sale on the BBS,
  211.      by the Sysop and the Notes are also a good place to mention this.
  212.  
  213.      In lieu of direct Sysop participation (i.e. if you don't find an
  214.      ICOMAUTO.ZIP on a new BBS you call), anyone who uses Intellicomm
  215.      regularly on the BBS can set up and upload the Auto-BIF.  You don't have
  216.      to be an Intellicomm expert to set an Auto-BIF up, and in fact, the Auto-
  217.      BIF might even be the first and only BIF you've ever set up.  As long as
  218.      your BIF works, you're fully qualified to create the ICOMAUTO.ZIP.
  219.  
  220.  
  221.      HOW ARE THESE FILES SET UP?
  222.  
  223.      It's no different than setting up any other BIF, at the start.  Use the
  224.      BIF Learn mode to create the BIF, then use it for a few days doing mail
  225.      runs, file uploads and downloads, new files list imports, and bank
  226.      transactions if available.
  227.  
  228.      Once you know the BIF is working properly you then just replace your own
  229.      name on the BIF "Logon" screen with %FIRST% and %LAST% (making sure to
  230.      leave any special formatting intact... e.g. %FIRST%^M%LAST%).  Then move
  231.      to the 'External Extras' on Wildcat-oriented BIFs and enter %BDATE% and
  232.      %HPHONE% before the ^M (make sure to leave the ^M after the parameter;
  233.      %BDATE%^M).  That's all there is to the setup.  Save the BIF, compress it
  234.      into an archive called ICOMAUTO.ZIP, then upload it to the BBS for others
  235.      to use.
  236.  
  237.      *IMPORTANT*:  Make sure to give the BIF a good looking over when adding
  238.      the replaceable parameters so you don't miss any PROMPTS that should also
  239.      use replaceable parms.  I.e. if your Logon "Confirm" prompt is using
  240.      "Lastname [Y/N]?" then you should define this as "%LAST% [Y/N]?" in for
  241.      the ICOMAUTO.  If you leave YOUR lastname in the BIF, the prompt will not
  242.      match when someone with a different name uses the BIF.  It is not
  243.      recommended that you use "%FIRST% %LAST% [Y/N]?" as a confirm prompt,
  244.      even though that's how many BBS's ask for it, because someone with a very
  245.      long name would overflow the prompt!  This would cause Icom to truncate
  246.      the information.  Twenty characters are the maximum per prompt, so
  247.      "MYNAMEIS RATHERLONG" would end up as "MYNAMIS RATHE [Y/N]?", if you used
  248.  
  249.  
  250.  
  251.  
  252.      Intellicomm v2.01             AUTOICOM.DOC                             5
  253.      
  254.      
  255.  
  256.      both %FIRST% and %LAST% in the prompt.  This theorically could even
  257.      happen with a longer %LAST% name only... so be careful when using name
  258.      parameters in prompts and make sure to use as little 'extra' text as
  259.      possible (e.g. "%LAST% [Y" instead of "%LAST% [Y/N]?").
  260.  
  261.      DON'T GET OVER-ANXIOUS
  262.  
  263.      Save adding the replaceable paramters to your Auto-BIF until AFTER you
  264.      have done all testing, and are ready to post it on the BBS.  If you enter
  265.      %FIRST% %LAST% in the BIF prematurely -- and then must later "Edit" the
  266.      BIF for some reason (to change a prompt or command), Intellicomm will ask
  267.      you for your first and last name each time you Edit the BIF... which will
  268.      waste your time and force you to re-enter your replaceable parameters. 
  269.      TIP: Icom will NOT actually replace the %PARAMETER% if you PRESS THE ESC
  270.      KEY when asked for the information.  I.e. if you are asked for your FIRST
  271.      NAME and you don't want the parameter replaced, press Esc and %FIRST%
  272.      will be left in the BIF intact, and your name will not replace the
  273.      parameter.
  274.  
  275.      ON NOT OVER-DOING IT
  276.  
  277.      Don't use replaceable parameters unless you have to.  Some of the
  278.      parameters are only of use/intended for new templates (for a new BBS type
  279.      or Bank/Message Type File).  In most cases Auto-BIFs will be set up with
  280.      a specific BBS in mind, and the only replaceable parameters you'll need
  281.      are %FIRST% and %LAST%, and possibly %BDATE% %HPHONE%.  Usually every
  282.      other item in the BIF can be set up ahead of time.  If a packet name is
  283.      used in the BBS's Mail Door, don't use %PNAME% and hope that the user
  284.      will know the packet name ... simply specify (hardcode) the proper packet
  285.      name(s) in the BIF.  Instead of using %DOOR%, call the BBS and find out
  286.      what the proper door name/number is.  Many people won't know the proper
  287.      door number, etc., so it's always much safer to define it yourself,
  288.      wherever possible.
  289.  
  290.      ON NOT UNDER-DOING IT
  291.  
  292.      However, don't take this too far.  If NO replaceable parameters are found
  293.      in a BIF, Intellicomm doesn't consider it an Auto-BIF, and it won't ask
  294.      the user for his/her BBS password nor ask whether to create a set of
  295.      standard Jobs.  So even if you know the person's name you're setting the
  296.      BIF up for, you should still use at least the %FIRST% %LAST% parameters
  297.      so that Intellicomm will treat the BIF as an Auto-BIF.
  298.  
  299.      Don't be fancy with these BIFs.  If there's a fancy, less reliable way of
  300.      doing something... and a clunkier but MORE reliable way to do something -
  301.      - choose the clunky more reliable method.  You can always place comments
  302.      in the BIF Notes if you like, giving tips for future enhancements, but
  303.      the objective of the Auto-BIF is to get a new user up and running quickly
  304.      and RELIABLY, so always favor reliability even if it hampers performance
  305.      slightly.
  306.  
  307.      Use Intellicomm's internal Zmodem as the Message/File Send and Receive
  308.      protocols wherever possible (and make sure to check the BBS Letters on
  309.      the protocol menu, in case the user doesn't have a default protocol set
  310.  
  311.  
  312.  
  313.  
  314.      Intellicomm v2.01             AUTOICOM.DOC                             6
  315.      
  316.      
  317.  
  318.      up on the BBS).  While other protocols may be more efficient (HS/Link,
  319.      for example), you don't want to get into something this fancy in an Auto-
  320.      BIF since the user may not even have HSLINK.EXE let alone have plugged it
  321.      into Icom's external protocol menu.
  322.  
  323.      Most people just want to get up and running as quickly and easily as
  324.      possible on their first few tries with a new BBS/BIF, and many don't care
  325.      about performance -- as long as the job gets done, and they don't have to
  326.      do any extra work.  So if you just do your best to ensure that the job
  327.      does get done, with as little setup as possible, you'll have an Auto-BIF
  328.      that will serve the majority well -- and will also serve as a very good
  329.      starting point for the power users.
  330.  
  331.      ZIPPING IT UP
  332.  
  333.      Once your BIF is all ready to go with the proper % parameters, you're
  334.      ready to compress it and test it out.  To do so, change to your main
  335.      Upload Directory (\ICOM\SND by default) from the DOS prompt, then enter:
  336.  
  337.       PKZIP ICOMAUTO \ICOM\BIF\BIFNAME.BIF
  338.  
  339.      where BIFNAME is the filename of the BIF.  If you are going to include
  340.      multiple BIFs for the same BBS (one could be advanced/one novice, one
  341.      could be set up to use the NEWFILES catalog, another to use a GAMES
  342.      catalog, etc), then you would repeat the above command with each BIF, of
  343.      course, making sure that you also entered the replaceable parameters in
  344.      each BIF.  If you also wish to include BIFNAME.NEW list(s) (listings of
  345.      important or interesting BBS files), you would then enter the command:
  346.  
  347.       PKZIP ICOMAUTO \ICOM\LST\BIFNAME.NEW
  348.  
  349.      assuming you had the list in your regular 'List Directory'; if not
  350.      substitute with the proper path.  .NEW lists are simply file listings
  351.      captured from the BBS, though PLEASE don't included a massive .NEW list. 
  352.      People can do that on their own if they want to.  The purpose of this
  353.      feature is to include a few (no more than a couple of dozen) interesting
  354.      or important BBS files.  Again, you may also include multiple .NEW lists,
  355.      using different BIFNAMEs if necessary (though you should also include a
  356.      .BIF using the same base name of each .NEW list or they won't be of much
  357.      use).
  358.  
  359.      PKZIP isn't 'mandatory', but it is recommended since Icom uses the
  360.      Primary/Secondary unpacker commands, defined in each user's main setup,
  361.      to unpack ICOMAUTO.*  -- and 99% of the time, people will have PKUNZIP
  362.      defined as their primary unpacker and PKUNPAK as their secondary (the
  363.      Icom defaults).  So if you compress ICOMAUTO using ARJ, in all likelihood
  364.      the unpacking of the file will FAIL for most people, when Icom tries to
  365.      install it.
  366.  
  367.      FINAL TESTING (UGH ... BUT IT'S WORTH IT!)
  368.  
  369.      By this point you're probably POSITIVE that your BIF is all set up
  370.      properly and you just want to upload it.  But to save yourself some
  371.      possible embarrassment, it is recommended that you give it the final
  372.  
  373.  
  374.  
  375.  
  376.      Intellicomm v2.01             AUTOICOM.DOC                             7
  377.      
  378.      
  379.  
  380.      once-over.  I have been 'positive' that Auto-BIFs were all configured
  381.      properly many times... only to have found major mistakes on the very last
  382.      test.
  383.  
  384.      Once ICOMAUTO.ZIP has been created in your Upload Directory, and you
  385.      think it's ready for upload, you should then copy it to your Download
  386.      Directory to simulate that you had just downloaded it from the BBS.  Then
  387.      start Intellicomm and ensure that the file does install properly, display
  388.      the BBS notes (if any) that you wanted, and ask the right questions. 
  389.      After you enter Intellicomm, change to the "BBS Dir" with [Alt-D] and
  390.      give the newly installed BIF(s) a final going over with the "Edit"
  391.      command, to ensure that everything ended up as you wanted it.  If you
  392.      included .NEW list(s) you might also check to ensure that it/they
  393.      imported to the Tagger correctly.  If all's well, then ICOMAUTO.ZIP is
  394.      already in your Upload Directory and you're ready to upload it to the
  395.      BBS!  The recommended description you use for the file is "Intellicomm
  396.      Auto-BIF for BBS Name"; BBS Name being the name of the BBS.  Please note
  397.      that Intellicomm has two l's and two m's (consistency in spelling is
  398.      important when people do file searches on the BBS to locate the
  399.      ICOMAUTO).
  400.  
  401.      FIXING MISTAKES
  402.  
  403.      If you did find one or more a mistakes in the final test, fix them up and
  404.      don't forget to update ICOMAUTO.ZIP with the fix.  If the mistake was in
  405.      a .NEW list then you can simply edit the list with your editor and
  406.      perform the PKZIP command again to replace the .NEW file in
  407.      \ICOM\SND\ICOMAUTO.ZIP.  If the problem was with a .BIF then you should
  408.      exit Intellicomm, change to \ICOM\BIF then COPY BIFNAME.OLD BIFNAME.BIF
  409.      (.OLD is the existing BIF as it was in your BIF directory [should have
  410.      all the replaceable parms, etc.] before the ICOMAUTO.ZIP was installed). 
  411.      Then start Icom, enter the BIF Editor (making sure to press ESC when
  412.      asked any questions) and fix up your errors, re-save the .BIF -- then go
  413.      back up to "ZIPPING IT UP".  It's a bigger job to fix up errors found in
  414.      the final testing... which is why you should make absolutely sure that
  415.      you've done everything properly BEFORE you think about adding the
  416.      replaceable parameters and compressing up ICOMAUTO.ZIP.
  417.  
  418.      Thanks for participating, and may you find many an ICOMAUTO.ZIP created
  419.      by OTHER Icom users on the new BBS's you call in the future!
  420.